home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 4 / The Pier Shareware #4 (The Pier Exchange) (1994).ISO / thepier / thepier.doc < prev    next >
Text File  |  1994-03-08  |  16KB  |  365 lines
  1.  
  2.  
  3.                    The Pier Shareware CD-ROM
  4.             Copyright (c) 1994 The Pier Exchange Inc..
  5.                       All rights reserved.
  6.  
  7.           ThePier(tm) - High Performance CD-ROM Access
  8.  
  9.  
  10.  
  11.  
  12.                        Retrieval Engine
  13.               Copyright (c) 1993 RoboSoft Systems.
  14.                       All rights reserved.   
  15.  
  16.  
  17.  
  18.  
  19.                          Table of Contents
  20.  
  21.     1 ........................................ Introduction
  22.     2 ........................................ Installation
  23.     3 ..................................... Basic Operation
  24.     4 .................................... The Subject List
  25.     4.1 ............................. The Subject List Menu
  26.     4.1.1 ................................. The System Menu
  27.     4.1.2 ................................. The Search Menu
  28.     4.1.3 .............................. The Configure Menu
  29.     4.1.3.1 ............................. Configure Display
  30.     4.1.3.2 ............................ Configure Database
  31.     4.1.3.3 ......................... Configure Directories
  32.     4.1.3.4 ............................. Configure Viewers
  33.     4.1.3.4.1 .............................. Default Viewer
  34.     4.1.3.4.2 ................................ Custom Shell
  35.     4.1.3.4.3 ............................... Smart Viewers
  36.     5 ...................................... The Files List
  37.     5.1 ............................... The Files List Menu
  38.     6 .............................. The File Detail Screen
  39.     6.1 .................................. The Content List
  40.     6.2 .............................. The File Detail Menu
  41.     7 ..................... Technical Questions and Support
  42.  
  43.  
  44.  
  45.  
  46.  
  47. 1. Introduction
  48.  
  49.  
  50. Congratulations on your purchase of one of The Pier Shareware
  51. CD-ROMs, the finest shareware CD-ROMs available.  ThePier(tm)
  52. CD-ROM Access program will assist you in finding files on your
  53. CD-ROM and performing common operations on those files.  It will
  54. allow you to view the filenames and descriptions of the files,
  55. search the CD-ROM files for filenames, keywords, and archive
  56. content filenames, and view many of the content files.
  57.  
  58.  
  59. 2. Installation
  60.  
  61.  
  62. To install ThePier(tm) CD-ROM Access program, change to the root
  63. directory of The Pier Shareware CD-ROM and type INSTALL.  The
  64. install program will ask where on your hard drive you want
  65. ThePier(tm) CD-ROM Access program to reside and will copy all
  66. necessary files to that directory.  (For performance reasons,
  67. ThePier(tm) must be installed to a hard disk.  It can not be run
  68. directly from the CD-ROM.)  ThePier(tm) requires approximately 1MB
  69. of disk space for the program and associated data files. Additional
  70. disk space will be used for the comments you enter in the comment
  71. database.
  72.  
  73.  
  74. 3. Basic Operation
  75.  
  76.  
  77. You should find ThePier(tm) very easy and intuitive to operate.  To
  78. start ThePier(tm), change to the directory where ThePier(tm) was
  79. installed (for example, CD \THEPIER) and type THEPIER.
  80.  
  81. ThePier(tm) is designed to use the best available video mode your
  82. computer will support.  By default, it will try to use graphics
  83. mode (EGA or VGA required) and resort to text mode if graphics mode
  84. is unavailable.  If you have problems viewing the screens in
  85. graphics mode, you can force the program into text mode by using a
  86. /T parameter on the command line (i.e. THEPIER /T). Graphics mode
  87. also requires the file EGAVGA.BGI to be present in the directory
  88. where THEPIER.EXE resides.  (The install program will put it
  89. there.)  If this file isn't present, ThePier(tm) will use a text
  90. mode display.
  91.  
  92. Online help is available throughout ThePier(tm).  Press F1 to view
  93. the context-sensitive help screens.
  94.  
  95.  
  96. 4. The Subject List
  97.  
  98.  
  99. The first screen you see when you start ThePier(tm) is a list of
  100. the subjects available on The Pier Shareware CD-ROM.  If you have a
  101. mouse on your system, a mouse pointer will be displayed.  You can
  102. use the mouse to click on any of the subjects, the items on the
  103. menu bar on the top of the screen, or on the scroll bar to the
  104. right of the screen.  If you click on a subject, a list of the
  105. files in that subject will appear.
  106.  
  107. 4.1  The Subject List Menu
  108.  
  109. At the top of the subject screen you'll see a drop-down menu bar
  110. containing System, Search, and Configure.
  111.  
  112. 4.1.1  The System Menu
  113.  
  114. At this point there are three options on the System menu:
  115.  
  116.     1) Shell to DOS, keeping ThePier(tm) in memory and ready
  117.        to go when you type EXIT at the DOS prompt.  
  118.     2) Execute a Custom Shell program.  (This will be        
  119.        covered in more detail under Configuration.)      
  120.     3) Exit ThePier(tm).
  121.  
  122. 4.1.2  The Search Menu
  123.  
  124. The Search menu will allow you to search ThePier(tm) database for
  125. matching file names, keywords, or content file names.  In this
  126. context, file names refers to the names of the files on The Pier
  127. Shareware CD-ROM, many of them archive files; keywords refers to
  128. significant words used in the file descriptions; and content file
  129. names refers to the files that are contained within the archive
  130. files.  At this point (on the Subjects List screen), searches will
  131. included all subjects.  If you wanted to search for all files that
  132. might have something to do with Windows, you would select Keyword
  133. from the search menu and type WINDOWS in the prompt box.
  134. ThePier(tm) will then display a list of all the files containing
  135. the word "windows" somewhere in their description.
  136.  
  137. Wildcard characters are not recognized in search strings, but
  138. partial strings are allowed if the Exact Match box is not checked.
  139. For instance, you could have entered WIN in the search above and
  140. matched all occurrences of Windows (along with all other keywords
  141. that begin with the letters WIN).
  142.  
  143. 4.1.3  The Configure Menu
  144.  
  145. The Configure menu allows you to change the operational parameters
  146. used by ThePier(tm).  You can force the display to text mode
  147. (meaning you wouldn't need the /T on the command line), change the
  148. active database (useful if you have more than one The Pier
  149. Shareware CD-ROM), change the directories used by ThePier(tm) for
  150. temporary files, and set up viewer programs to be called
  151. automatically when certain files are selected. On all of the
  152. configuration screens, if you press ESCape, any changes you entered
  153. on that screen will be thrown away and the old data will be
  154. restored.
  155.  
  156. 4.1.3.1  Configure Display
  157.  
  158. The Configure Display screen allows a simple choice between forcing
  159. ThePier(tm) to use text mode displays or allowing it to use
  160. graphics mode displays.  (Graphics mode requires an EGA or VGA
  161. display system.)  Graphics mode displays are slightly larger than
  162. text mode, allowing more subjects and files to be displayed on a
  163. single screen, but they are slightly slower than text mode
  164. displays.  Other than these minor differences, the two modes are
  165. functionally identical.
  166.  
  167. 4.1.3.2  Configure Database
  168.  
  169. The Configure Database screen can be used to select an alternate
  170. ThePier(tm) database.  If you have more than one The Pier Shareware
  171. CD-ROM you can use this screen to select the database associated
  172. with one of the other CD-ROMs.  If you only have one The Pier
  173. Shareware CD-ROM, do not change the settings on this screen.
  174.  
  175. You can select any of the directories shown in the lower right
  176. section by clicking on them with your mouse.  If you don't have a
  177. mouse, use the TAB key to switch to the directory section, then use
  178. the arrow keys to highlight the desired directory. Press the ENTER
  179. key to select the directory.
  180.  
  181. If the desired directory is on another drive, position to the Dir
  182. field and type the desired drive letter.
  183.  
  184. When you've selected the proper directory, position to the left
  185. window and select the desired database file.  To finalize the
  186. database selection, position to and select the OK button.
  187.  
  188. 4.1.3.3  Configure Directories
  189.  
  190. Directories Configuration allows you to specify the directories
  191. used by ThePier(tm).  The Work Directory is used by ThePier(tm) for
  192. temporary files. A default value is set up by the installation
  193. program, but you can change it if desired.  The Work Directory
  194. should be on a drive that has free space at least as large as the
  195. largest file you intend to view.  (Five megabytes should be more
  196. than sufficient.)
  197.  
  198. The Default Copy/Extract Directory specifies the default directory
  199. used when copying or extracting archive files.  This is just a
  200. default and can be changed on the fly when copying or extracting
  201. files.
  202.  
  203. The Comment Database Directory specifies the location of the
  204. comment database.  By default, this is the directory where
  205. ThePier(tm) program resides.  It is recommended that you stay with
  206. the default.
  207.  
  208. CD-ROM Drive specifies the drive letter of your CD-ROM drive. The
  209. installation program initially sets this value to the drive from
  210. which ThePier(tm) was installed.  If you have more than one CD-ROM
  211. drive, you will need to change this value if you move The Pier
  212. Shareware CD-ROM to a different CD-ROM drive.
  213.  
  214. 4.1.3.4  Configure Viewers
  215.  
  216. The viewers are one of the nicest features of ThePier(tm).  They
  217. allow you to associate programs with data files on the basis of the
  218. data file extension.  The Viewer configuration screen is divided
  219. into several areas.
  220.  
  221. 4.1.3.4.1  Default Viewer
  222.  
  223. At the top of the screen is the default viewer.  This is the viewer
  224. program that is called whenever the selected file does not match
  225. one of the file extensions specified on this screen. ThePier(tm)
  226. has a built-in viewer that is used as the default viewer unless you
  227. specify something different.  Leave the Default Viewer field blank
  228. if you want to use the built-in viewer.  (The built-in viewer is
  229. designed to work only with plain ASCII text files and will view
  230. only the first 32k bytes of any file.  If you plan to view
  231. non-ASCII files or very large files, you will probably want to
  232. specify a different program as the default viewer.  Vern Buerg's
  233. LIST program is an excellent choice for the default viewer.)
  234.  
  235. To specify a different default viewer, enter what you would
  236. normally type at the DOS command line to start that program. Where
  237. you would ordinarily type the name of the file to be viewed, enter
  238. $F.  ThePier(tm) will replace the $F with the name of the file
  239. you've selected for viewing.  If you wanted to use Vern Buerg's
  240. LIST program as your default viewer, your default viewer line might
  241. look like:
  242.  
  243.       Default Viewer: LIST $F
  244.  
  245. 4.1.3.4.2  Custom Shell
  246.  
  247. The next field allows you to specify a "shell" program. This is
  248. intended for use with DOS "shell" programs such as PCTools Shell
  249. and Norton Commander.  ThePier(tm) will allow you to jump directly
  250. to the program specified in this field and return to ThePier(tm)
  251. when you exit the shell program.  If your DOS shell can accept a
  252. directory on the command line, you can use $D to designate the
  253. current working directory.  If you use the Extract and Custom Shell
  254. option, $D will be the directory into which the file was extracted.
  255. If you wanted to use PCTools Shell as your shell program, your
  256. shell program line might look like:
  257.  
  258.         Shell Program: PCSHELL $D
  259.  
  260. 4.1.3.4.3  Smart Viewers
  261.  
  262. The other viewers are all paired with a line of file extensions
  263. associated with that viewer.  Anytime you select a file with an
  264. extension from the viewer list, the viewer program associated with
  265. that extension will be executed.  The viewer command lines are just
  266. like the Default Viewer line as far as format goes. Use $F in the
  267. command where you want the file name to go.
  268.  
  269.  
  270. 5.  The Files List
  271.  
  272.  
  273. When you select one of the subjects on the Subjects List, you'll
  274. see a list of the files in that subject along with as much of the
  275. file description as will fit on a single line.  If you select one
  276. of the files by clicking on it with your mouse or pressing enter
  277. when the file is highlighted, you'll see detailed information about
  278. that file.
  279.  
  280. 5.1  The Files List Menu
  281.  
  282. At the top of the files list screen you'll notice the menu bar has
  283. changed.  System is still there, though it now contains an
  284. additional "Return to previous menu" item.  (You can also return to
  285. the previous screen by pressing ESCape or clicking on the little
  286. box in the upper left corner of the file list window.) The Search
  287. menu is still there too, but its function has changed a bit.  At
  288. this point searches will not scan the entire database, but will be
  289. limited to the subject currently selected.
  290.  
  291.  
  292. 6.  The File Detail Screen
  293.  
  294.  
  295. The File Detail Screen contains detailed information about the file
  296. you've selected.  In the upper left of the detail screen is the
  297. file name, location, size, and date.  In the upper right is a list
  298. of the contents of this file.  (If the file is not an archive file,
  299. you'll just see the file name again.)  In the middle of the screen
  300. is the full file description.  The scroll bar at the right of the
  301. file description box can be used if the full description doesn't
  302. fit in the available lines.
  303.  
  304. Toward the bottom of the screen is a box where you can enter your
  305. own comments about this file.  These comments will be saved in a
  306. database on your hard disk and redisplayed when you view this
  307. file's detail information again.
  308.  
  309. At the very bottom of the screen is a prompt bar.  Pressing any of
  310. the specified keys will perform the indicated action.  You can also
  311. click with your mouse on any of the words to take the indicated
  312. action.
  313.  
  314. 6.1  The Content List
  315.  
  316. The content list in the upper right of the detail screen is where
  317. the viewers come in.  If you select one of the files in the content
  318. list, that file will be extracted from the archive (if necessary)
  319. and passed to the appropriate viewer program.  If no viewer is
  320. associated with the selected file extension, the default viewer
  321. will be used.  (When ThePier(tm) executes a viewer, it swaps all
  322. but about 10k of itself to EMS or to disk, so the viewer program
  323. should have plenty of memory available.)
  324.  
  325. 6.2  The File Detail Menu
  326.  
  327. At the top of the file detail screen you'll see the familiar System
  328. menu along with a File menu.  The File menu will allow you to copy
  329. a complete file or to extract an archive file.  If you select
  330. either of these options, you'll be prompted for a destination
  331. directory for the copy or extract operation.  These directories
  332. will default to the Copy and Work directories specified in the
  333. configuration menu off the subjects screen. You can change them by
  334. selecting a different directory from the displayed list.  If you
  335. want the files to go to a different drive, you'll have to type the
  336. drive letter on the directory line.
  337.  
  338. The File menu will also allow you to Extract and execute the Custom
  339. Shell or Extract and Shell to DOS.  Both of these options will
  340. allow you to select a directory for the extract operation and will
  341. then either execute your Custom Shell or shell to DOS in the
  342. extraction directory.
  343.  
  344.  
  345. 7.  Technical Questions and Support
  346.  
  347.  
  348. If you have trouble installing ThePier(tm), contact The Pier
  349. Exchange Inc. at:
  350.               80 W. Hazeltine
  351.               Kenmore, NY 14217
  352.  
  353.               Info (716) 875-4931
  354.               BBS (716) 875-3130
  355.  
  356. If you have detailed technical questions or comments about the
  357. access software, you can contact RoboSoft Systems, the authors of
  358. the retrieval engine, at:
  359.  
  360.                         RoboSoft Systems
  361.                         P.O. Box 2221
  362.                         Orange, CA  92669
  363.  
  364.  
  365.